using System;
using System.Runtime.Serialization;

namespace Synergy
{
	/// <summary>
	/// That exception that is thrown when an attempt is made to access the 
	/// <see cref="SharedServiceLocator"/> before it has been initialized.
	/// </summary>
	/// <remarks>
	///		<list type="table">
	///			<listheader><term>Version</term><description>Description</description></listheader>
	///			<item>
	///				<term>1.0</term>
	///				<description>Initial version</description>
	///			</item>
	///		</list>
	/// </remarks>
	[Serializable]
	public class ServiceLocatorNotInitializedException : Exception
	{
		#region | Fields |

		private const string DefaultMessage = "The service locator has not been initialized with a valid container.";

		#endregion


		#region | Initialization |

		/// <summary>
		/// Initializes a new instance of the <see cref="ServiceLocatorNotInitializedException"/> class.
		/// </summary>
		public ServiceLocatorNotInitializedException() : base(DefaultMessage)
		{ }


		/// <summary>
		/// Initializes a new instance of the <see cref="ServiceLocatorNotInitializedException"/> class.
		/// </summary>
		/// <param name="message">The message.</param>
		public ServiceLocatorNotInitializedException(string message) : base(message)
		{ }


		/// <summary>
		/// Initializes a new instance of the <see cref="ServiceLocatorNotInitializedException"/> class.
		/// </summary>
		/// <param name="message">The message.</param>
		/// <param name="innerException">The inner exception.</param>
		public ServiceLocatorNotInitializedException(string message, Exception innerException) : base(message, innerException)
		{ }


		/// <summary>
		/// Initializes a new instance of the <see cref="ServiceLocatorNotInitializedException"/> class.
		/// </summary>
		/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
		/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
		/// <exception cref="T:System.ArgumentNullException">
		/// The <paramref name="info"/> parameter is null.
		/// </exception>
		/// <exception cref="T:System.Runtime.Serialization.SerializationException">
		/// The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
		/// </exception>
		protected ServiceLocatorNotInitializedException(SerializationInfo info, StreamingContext context) : base(info, context)
		{ }

		#endregion
	}
}